<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>gpio: xgpio.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">gpio
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xgpio_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xgpio.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_gpio___config.html">XGpio_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the device.  <a href="struct_x_gpio___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_gpio.html">XGpio</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_gpio.html" title="The XGpio driver instance data. ">XGpio</a> driver instance data.  <a href="struct_x_gpio.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga00bfede0e6dcb1bac3e63d0e35d993f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga00bfede0e6dcb1bac3e63d0e35d993f0">XGPIO_H</a></td></tr>
<tr class="memdesc:ga00bfede0e6dcb1bac3e63d0e35d993f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">by using protection macros  <a href="group__gpio__api.html#ga00bfede0e6dcb1bac3e63d0e35d993f0">More...</a><br/></td></tr>
<tr class="separator:ga00bfede0e6dcb1bac3e63d0e35d993f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga080482882d1f60cbd84b8e4ea856560c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga080482882d1f60cbd84b8e4ea856560c">XGpio_Initialize</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:ga080482882d1f60cbd84b8e4ea856560c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the <a class="el" href="struct_x_gpio.html" title="The XGpio driver instance data. ">XGpio</a> instance provided by the caller based on the given DeviceID.  <a href="group__gpio__api.html#ga080482882d1f60cbd84b8e4ea856560c">More...</a><br/></td></tr>
<tr class="separator:ga080482882d1f60cbd84b8e4ea856560c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b208ffd7b19c2176d459223bc63ea14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_gpio___config.html">XGpio_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga3b208ffd7b19c2176d459223bc63ea14">XGpio_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:ga3b208ffd7b19c2176d459223bc63ea14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookup the device configuration based on the unique device ID.  <a href="group__gpio__api.html#ga3b208ffd7b19c2176d459223bc63ea14">More...</a><br/></td></tr>
<tr class="separator:ga3b208ffd7b19c2176d459223bc63ea14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf76e70c9ddd0dc3966123c09646d880c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#gaf76e70c9ddd0dc3966123c09646d880c">XGpio_CfgInitialize</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, <a class="el" href="struct_x_gpio___config.html">XGpio_Config</a> *Config, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:gaf76e70c9ddd0dc3966123c09646d880c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the <a class="el" href="struct_x_gpio.html" title="The XGpio driver instance data. ">XGpio</a> instance provided by the caller based on the given configuration data.  <a href="group__gpio__api.html#gaf76e70c9ddd0dc3966123c09646d880c">More...</a><br/></td></tr>
<tr class="separator:gaf76e70c9ddd0dc3966123c09646d880c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabee6bcad28382ef5ecd336887647c238"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#gabee6bcad28382ef5ecd336887647c238">XGpio_SetDataDirection</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, unsigned Channel, u32 DirectionMask)</td></tr>
<tr class="memdesc:gabee6bcad28382ef5ecd336887647c238"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the input/output direction of all discrete signals for the specified GPIO channel.  <a href="group__gpio__api.html#gabee6bcad28382ef5ecd336887647c238">More...</a><br/></td></tr>
<tr class="separator:gabee6bcad28382ef5ecd336887647c238"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga77090853c15dc3d72e2bfbc66e635ada"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga77090853c15dc3d72e2bfbc66e635ada">XGpio_GetDataDirection</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, unsigned Channel)</td></tr>
<tr class="memdesc:ga77090853c15dc3d72e2bfbc66e635ada"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the input/output direction of all discrete signals for the specified GPIO channel.  <a href="group__gpio__api.html#ga77090853c15dc3d72e2bfbc66e635ada">More...</a><br/></td></tr>
<tr class="separator:ga77090853c15dc3d72e2bfbc66e635ada"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed95c58f21d567fca624f9f51cb25e20"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#gaed95c58f21d567fca624f9f51cb25e20">XGpio_DiscreteRead</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, unsigned Channel)</td></tr>
<tr class="memdesc:gaed95c58f21d567fca624f9f51cb25e20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads state of discretes for the specified GPIO channel.  <a href="group__gpio__api.html#gaed95c58f21d567fca624f9f51cb25e20">More...</a><br/></td></tr>
<tr class="separator:gaed95c58f21d567fca624f9f51cb25e20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae188a28725318c991ac45afb2452ad9b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#gae188a28725318c991ac45afb2452ad9b">XGpio_DiscreteWrite</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, unsigned Channel, u32 Mask)</td></tr>
<tr class="memdesc:gae188a28725318c991ac45afb2452ad9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes to discretes register for the specified GPIO channel.  <a href="group__gpio__api.html#gae188a28725318c991ac45afb2452ad9b">More...</a><br/></td></tr>
<tr class="separator:gae188a28725318c991ac45afb2452ad9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f2cea7ef78412c03c7ebdba87b7cdd4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga8f2cea7ef78412c03c7ebdba87b7cdd4">XGpio_DiscreteSet</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, unsigned Channel, u32 Mask)</td></tr>
<tr class="memdesc:ga8f2cea7ef78412c03c7ebdba87b7cdd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set output discrete(s) to logic 1 for the specified GPIO channel.  <a href="group__gpio__api.html#ga8f2cea7ef78412c03c7ebdba87b7cdd4">More...</a><br/></td></tr>
<tr class="separator:ga8f2cea7ef78412c03c7ebdba87b7cdd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae430718af9f347c91be42aad580b216c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#gae430718af9f347c91be42aad580b216c">XGpio_DiscreteClear</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, unsigned Channel, u32 Mask)</td></tr>
<tr class="memdesc:gae430718af9f347c91be42aad580b216c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set output discrete(s) to logic 0 for the specified GPIO channel.  <a href="group__gpio__api.html#gae430718af9f347c91be42aad580b216c">More...</a><br/></td></tr>
<tr class="separator:gae430718af9f347c91be42aad580b216c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf01e2f4d8e75fa4922a5d92798be7b25"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#gaf01e2f4d8e75fa4922a5d92798be7b25">XGpio_SelfTest</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf01e2f4d8e75fa4922a5d92798be7b25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Runs a self-test on the driver/device.  <a href="group__gpio__api.html#gaf01e2f4d8e75fa4922a5d92798be7b25">More...</a><br/></td></tr>
<tr class="separator:gaf01e2f4d8e75fa4922a5d92798be7b25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga116bf1509220aa688f76f80501eb0d9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga116bf1509220aa688f76f80501eb0d9e">XGpio_InterruptGlobalEnable</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga116bf1509220aa688f76f80501eb0d9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the interrupt output signal.  <a href="group__gpio__api.html#ga116bf1509220aa688f76f80501eb0d9e">More...</a><br/></td></tr>
<tr class="separator:ga116bf1509220aa688f76f80501eb0d9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6241d0ae28815c258bb89a61ce0a6366"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga6241d0ae28815c258bb89a61ce0a6366">XGpio_InterruptGlobalDisable</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga6241d0ae28815c258bb89a61ce0a6366"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the interrupt output signal.  <a href="group__gpio__api.html#ga6241d0ae28815c258bb89a61ce0a6366">More...</a><br/></td></tr>
<tr class="separator:ga6241d0ae28815c258bb89a61ce0a6366"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa5b62394f65ecbb6566d91412616509c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#gaa5b62394f65ecbb6566d91412616509c">XGpio_InterruptEnable</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:gaa5b62394f65ecbb6566d91412616509c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable interrupts.  <a href="group__gpio__api.html#gaa5b62394f65ecbb6566d91412616509c">More...</a><br/></td></tr>
<tr class="separator:gaa5b62394f65ecbb6566d91412616509c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21c295f935fdc4e37c9f958b3652fbf6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga21c295f935fdc4e37c9f958b3652fbf6">XGpio_InterruptDisable</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga21c295f935fdc4e37c9f958b3652fbf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable interrupts.  <a href="group__gpio__api.html#ga21c295f935fdc4e37c9f958b3652fbf6">More...</a><br/></td></tr>
<tr class="separator:ga21c295f935fdc4e37c9f958b3652fbf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5138b55159f8b2387f5cf16079b40bbe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga5138b55159f8b2387f5cf16079b40bbe">XGpio_InterruptClear</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga5138b55159f8b2387f5cf16079b40bbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears pending interrupts with the provided mask.  <a href="group__gpio__api.html#ga5138b55159f8b2387f5cf16079b40bbe">More...</a><br/></td></tr>
<tr class="separator:ga5138b55159f8b2387f5cf16079b40bbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e5e23001aa3d35febe4859270ede71e"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga1e5e23001aa3d35febe4859270ede71e">XGpio_InterruptGetEnabled</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga1e5e23001aa3d35febe4859270ede71e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the interrupt enable mask.  <a href="group__gpio__api.html#ga1e5e23001aa3d35febe4859270ede71e">More...</a><br/></td></tr>
<tr class="separator:ga1e5e23001aa3d35febe4859270ede71e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95b0fa50ff962243ea284a4a767fe01e"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__api.html#ga95b0fa50ff962243ea284a4a767fe01e">XGpio_InterruptGetStatus</a> (<a class="el" href="struct_x_gpio.html">XGpio</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga95b0fa50ff962243ea284a4a767fe01e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the status of interrupt signals.  <a href="group__gpio__api.html#ga95b0fa50ff962243ea284a4a767fe01e">More...</a><br/></td></tr>
<tr class="separator:ga95b0fa50ff962243ea284a4a767fe01e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
